Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
typedoc-plugin-missing-exports
Advanced tools
Automatically document symbols which aren't exported but are referenced.
Supports TypeDoc 0.22.x and 0.23.x
TypeDoc 0.20 switched from documenting each file individually to documenting based on entry points. TypeDoc looks at each provided entry point and documents all exports from that entry point.
For libraries which export their full exposed API, this works well, but some packages are extremely resistant to exporting everything. This plugin is for them. After TypeDoc has finished converting packages, it will look for types which are referenced, but not exported, and place them into an internal namespace for that entry point (called <internal>
by default).
If your project references classes which are built into the language (e.g. HTMLElement
), this package will result in those types being documented to. If you want to prevent this, set TypeDoc's excludeExternals
option to true
. The default pattern for determining if a symbol is external will exclude everything within node_modules
.
npm install typedoc-plugin-missing-exports
TypeDoc will automatically use this plugin when present.
internalNamespace
- Define the name of the namespace that internal symbols which are not exported should be placed into.0.23.0 (2022-06-26)
FAQs
Include non-exported types in TypeDoc documentation
We found that typedoc-plugin-missing-exports demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.